Artifact: Manual Styleguide
 Manual Styleguide |
Describes how the end-user support manuals should be described. |
| Worker: | Technical Writer |
| Enclosed in: | Software Development Plan |
| Input to Activities: | Output from Activities: |
Purpose
The purpose of the Manual Styleguide is to describe the stylistic conventions to be used to develop end-user support materials. A Manual Styleguide gives advice on, and rules for, spelling of general and domain-specific terms, sentence style, and technical writing issue.
Timing
Manual Styleguides are developed during the Elaboration Phase.
Tailoring
A Manual Styleguide is needed if there is a significant element of user documentation, including both printed and on-line documentation.
Additional Information
Try to use existing styleguides, since there are several good books
available. Examples of manual styleguides are [HAC97]
and [MOS98].
